Management API

Base Resource URL:

     https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]

Description:

Reseller code of a reseller, on which action is required.

In cases when an external identifier (Reference Number) is desired to be used in place of Reseller Code, the star (*) must be used, followed by the external identifier assigned to the reseller.

For example,

/resellers/1.xml - reseller identification is done using Reseller Code, in this case 1

/resellers/*004.xml - reseller identification is done using Reference Number, in this case 004

Available sub-resources:

Resource URL Description
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/adjustments    Represents information about scheduled adjustments and fees for reseller statements.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/business-info    Represents business information of the Reseller.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/channel    Represents Channels, associated with the given reseller.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/commissions    Commissions that are currently configured for the specified reseller.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/contact-info    Represents contact information of the Reseller.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/deposit-info    Represents information of the deposit account for commission payments. When any type of update (modify) action is performed, the real bank account information has to be supplied. For security purposes, when the information is requested for reading (load action is performed),
the masked value will be returned instead.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/merchant-entity    Represents a Merchant entity that is associated with the reseller for the purpose of transaction processing.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/merchants    Represents Merchants, associated with the given reseller.
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]/users    Represents Users, associated with the given reseller.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Reseller *      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Creates new reseller.

delete  
Method:  DELETE       Implicit:  Yes       Returns:  ServiceResponse      
Consumes:  xurl  Produces:  json, xml 
 
Deletes a selected reseller from the system.

load  
Method:  GET       Implicit:  Yes       Returns:  Reseller *      
Consumes:  xurl  Produces:  json, xml 
 
Returns settings of a selected reseller.

modify  
Method:  POST       Implicit:  Yes       Returns:  Reseller *      
Consumes:  xurl  Produces:  json, xml 
 
Updates existing resellers with the specified values.

Parameters:
# Name Type Required Default Description
01 object Reseller * Yes Updated object information.

Represents reseller object without sub-components.

Copyright © TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.